/*
 *
 * $Id: OutgoingMessageEvent.java,v 1.1 2005/05/03 06:38:25 hamada Exp $
 *
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
 *    must not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 */

package net.jxta.endpoint;

/**
 *  An event which provides notification of the the transmission status of an
 *  outgoing message. The source of the event is the Message object.
 */
public class OutgoingMessageEvent extends java.util.EventObject {

    // Two low-cost msg events for reporting to selectors: success does not require an exception. An exception is too expensive
    // for overflow.  The message component is useless for select but we need a dummy src in order to construct an Event.  Note,
    // to convert OVERFLOW or SUCCESS to listener-compatible events, clone them and set the message member. Other events are
    // already all right.
    public static final OutgoingMessageEvent SUCCESS = new OutgoingMessageEvent();
    public static final OutgoingMessageEvent OVERFLOW = new OutgoingMessageEvent();

    private Throwable failure = null;

    /**
     * Create an Outgoing Message Event with a dummy src (message
     * is not specified because the event is a constant).
     */
    public OutgoingMessageEvent() {
        super("Unspecified");
    }

    /**
     *  Create an Outgoing Message Event.
     *
     *  @param source the message for which the event is occuring.
     */
    public OutgoingMessageEvent(Message source) {
        super(source);
    }

    /**
     *  Create an Outgoing Message Event.
     *
     *  @param source The message for which the event is occuring.
     *  @param failure The failure associated with this event.
     */
    public OutgoingMessageEvent(Message source, Throwable failure) {
        super(source);

        this.failure = failure;
    }

    /**
     *  Get the failure associated with this event, if any.
     *
     *  @return the <code>Throwable</code> associated with the failure, if any. 
     *  <code>null</code> if there was no associated failure.
     */
    public Throwable getFailure() {
        return failure;
    }
}
